Retrieve Microsoft Operator Connect Calling Profiles
A calling profile is a logical container for trunks and emergency strings that are used for outbound routing and emergency calling configurations. Every calling profile has a global unique identifier. You can configure multiple calling profiles and a calling profile can have multiple trunks associated. Every PSTN number is associated with one calling profile. For failover, at least two trunks must be associated with the calling profile. All trunks will be in active-active mode and the traffic will be distributed randomly between the trunks.
At least one calling profile should be configured per region, however a calling profile for each market is not required. Every number is associated with a single calling profile. When the the Calling Profile is assigned to a customer, links are created in Live Cloud between the customer tenant and the SBC. In the example below, the Calling Profile OC.CUSTOMERS.AUDIO-CODE.CO.IL is configured with two SBC devices, "oc1.customers.audio-code.co.il" and "oc2.customers.audio-code.co.il". Once updated, two new links are generated in Live Cloud, one for each configured SBC device.
Calling profiles are preconfigured by AudioCodes Professional Services.
URL
{{baseUrl}}/api/v2/oc/callingprofileHTTP Method
GET
Example Response
[
{
"additionalSbcList": [],
"callingProfileId": "9097a8b4-1cc8-461c-af93-e5b14943f5d7",
"name": "PROD_AudioCodesRD_Calling_AC_EMEA",
"enviroment": null,
"region": null,
"carrier": null,
"offerTypes": [
{
"offerTypeName": "Calling",
"testNumbers": []
},
{
"offerTypeName": "AudioConferencing",
"testNumbers": []
}
],
"emergencyDialStrings": [
""
],
"isEmergencyProfile": false,
"emergencyProfileId": null,
"trunksEnrolled": [
{
"trunkFqdn": "oc.sandbox1.audiocodes.be",
"trunkId": "ecb022e4-cc18-499f-a625-6646dc55c2b4",
"matchingSbcList": [
{
"sbcId": 2,
"fqdn": "NL-SBC05.lab.lan",
"ipAddress": "172.17.239.165",
"name": "NL-SBC05"
}
]
}
],
"validation": {
"Calling": "NotRun",
"AudioConferencing": "NotRun",
"OCMobile": "NotRun"
}
},
{
"additionalSbcList": [],
"callingProfileId": "9dd77aaf-1179-4373-8dc4-c74bdd2b018d",
"name": "PROD_AudioCodesRD_Calling_AC_EMEA_Call_Conf",
"enviroment": null,
"region": null,
"carrier": null,
"offerTypes": [
{
"offerTypeName": "Calling",
"testNumbers": []
},
{
"offerTypeName": "AudioConferencing",
"testNumbers": []
}
],
"emergencyDialStrings": [
""
],
"isEmergencyProfile": false,
"emergencyProfileId": null,
"trunksEnrolled": [
{
"trunkFqdn": "oc2.customers.audio-code.co.il",
"trunkId": "87b50f79-65c8-4198-b9a4-e65d2fefae5a",
"matchingSbcList": []
},
{
"trunkFqdn": "oc1.customers.audio-code.co.il",
"trunkId": "8734a246-317e-4146-bf93-fb39f353b920",
"matchingSbcList": []
}
],
"validation": {
"Calling": "NotRun",
"AudioConferencing": "NotRun",
"OCMobile": "NotRun"
}
}
HTTP Responses
| ■ | 200 OK |
|
Parameter |
Type |
Description |
|||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
additionalSbcList |
list array |
List of SBC devices that are currently not mapped to any Calling Profile. |
|||||||||||||||||||||
|
callingProfileId |
string |
The unique Id of the Calling Profile. |
|||||||||||||||||||||
|
Name |
string |
The name of the calling profile. |
|||||||||||||||||||||
|
Environment |
string |
The name of the deployment environment. For example, “Production” or “Test” |
|||||||||||||||||||||
|
Region |
string |
The name of the deployment region. |
|||||||||||||||||||||
|
Carrier |
string |
Name of the Service Provider Operator carrier. |
|||||||||||||||||||||
|
Offer Types (Name) |
string |
The product offers serviced with the calling profile:
|
|||||||||||||||||||||
|
Offer Types (Test Numbers) |
list array |
The numbers used for testing the Offer Type functionality. A separate list exists for each of the above functionality. For validation testing of the offer type and the associated trunks, three test numbers should be provided with the offer type. |
|||||||||||||||||||||
|
Emergency Dial String |
list array |
The emergency dialing prefix strings. For example, 100. |
|||||||||||||||||||||
|
Only use for emergency calling |
boolean Default: False |
Determines whether this calling profile is only used for emergency calling. |
|||||||||||||||||||||
|
emergencyProfileId |
string |
The name of the emergency profile. |
|||||||||||||||||||||
|
Trunks Enrolled |
list array |
Lists the enrolled trunks (SBC devices that are attached to a Calling Profile):
If you have access to the Microsoft Operator Connect portal, you can view the Id in the browser URL by selecting the trunk under Trunks > Trunks & Calling Profiles > Trunk Management.
|
|||||||||||||||||||||
|
Validation |
boolean |
Indicates whether the following services are offered with the calling profile:
|
|||||||||||||||||||||
|
AdditionalSbcList |
list array |
List of SBC devices that are mapped to the Calling Profile.
This list appears when the FQDN of the SBC is different to the FQDN of the PSTN trunk. |
|||||||||||||||||||||
|
sbcId |
integer |
Id of the SBC device in the Live Cloud database. |
|||||||||||||||||||||
|
fqdn |
string |
SBC FQDN e.g. oc.sandbox1.audiocodes.be |
|||||||||||||||||||||
|
ipAddress |
integer |
IP address of the SBC device. |
|||||||||||||||||||||
|
name |
string |
Name of the SBC device in the Live Cloud database. |